REST API Interface
The Live Platform Rest API is designed for developer partners of Microsoft Direct Routing and Operator Connect who wish to integrate these Services into their solution and for partner operators who wish to perform management and configuration tasks.
| ■ | Operator Connect: Developer partner operators can utilize their REST API clients to synchronize with their Microsoft 365 platform for onboarding and Day Two management of their customers who commission the operator through their Teams admin center using Operator Connect. Operator Connect for Teams is a program that integrates both Microsoft and the Operator’s joint PSTN and mobile offerings according to service level agreements. |
| ■ | Direct Routing: The Live Platform Rest API is designed for developer partners. Developer partner operators can utilize their REST API clients to execute actions on their Microsoft 365 deployment for onboarding and Day Two management. |
What is a REST API?
API is short for ‘Application Programming Interface’. An API is a set of rules that lets programs talk to each other, exposing data and functionality across the Internet in a consistent format.
REST stands for Representational State Transfer. This is an architectural pattern that describes how distributed systems can expose a consistent interface. ‘REST API’, generally refers to an API accessed using the HTTP protocol with a predefined set of URLs. These URLs represent various resources — any information or content accessed at this specific location, which can be returned as JSON, HTML, audio files, or images. Often resources may have one or more methods that can be performed on them over HTTP. For this REST API, the following methods are used:
| ■ | GET: Read specific resources (items, data) from the target system. |
| ■ | POST: Create new resources into the target system. |
| ■ | PUT: update some existing resources, changing some properties (fields, entries). |
| ■ | PATCH: update some specific properties from some existing resources. |
| ■ | DELETE: request to delete some resources from the target system. |
The Live Platform Web server exposes specific product functionality. The calls for these functions can be executed using a REST API client. This document describes how to execute these calls using the Postman REST API client.